using Wilco.SyntaxHighlighting.Engine.Node.Implementation.CommentBlock;

namespace Wilco.SyntaxHighlighting.Engine.Node.Implementation.String
{
    /// <summary>
    /// Represents a string entity.
    /// </summary>
    public class StringEntity : Entity
    {
        private readonly string escape;

        /// <summary>
        /// Gets the string which is used to escape the end.
        /// </summary>
        public string Escape
        {
            get
            {
                return escape;
            }
        }

        /// <summary>
        /// Initializes a new instance of a <see cref="StringEntity"/> struct.
        /// </summary>
        /// <param name="start">The string which indicates the start of a string.</param>
        /// <param name="end">The string which indicates the end of a string.</param>
        /// <param name="escape">The string which is used to escape the end.</param>
        public StringEntity(string start, string end, string escape) : base(start, end)
        {
            this.escape = escape;
        }
    }
}